<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>PaleGem: Inc/IPaleGemFramework.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PaleGem
   &#160;<span id="projectnumber">0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_f93dfce691d792349f1c14ede440e2e6.html">Inc</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">IPaleGemFramework.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_i_pale_gem_framework_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347">    8</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347" title="Predefined error codes.">PG_ERROR</a></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;{</div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347ae2d5db0f557ffa4ba3b97cd337e6fcf7">   10</a></span>&#160;    <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347ae2d5db0f557ffa4ba3b97cd337e6fcf7">ER_NOT_ENOUGH_PHYS_RAM</a> = 1,</div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347afd3d058a7e6eb8465859ec4404ce6682">   11</a></span>&#160;    <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347afd3d058a7e6eb8465859ec4404ce6682">ER_NOT_ENOUGH_VIRT_RAM</a>,</div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347afdb8bcf29a97422222e6da94c7539626">   12</a></span>&#160;    <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347afdb8bcf29a97422222e6da94c7539626">ER_NOT_ENOUGH_HARD_DISK_SPACE</a>,</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347a9561d4a61cc96133598afd0d8ce62377">   13</a></span>&#160;    <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347a9561d4a61cc96133598afd0d8ce62377">ER_NULL_POINTER</a>,</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347aaa359761f664fb77d57f1c5c3ff1bc25">   14</a></span>&#160;    <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347aaa359761f664fb77d57f1c5c3ff1bc25">ER_D3D_INIT_FAILURE</a>,</div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347a8b96f3a36e85ca715fe56cdd9b40b32b">   15</a></span>&#160;    <a class="code" href="_i_pale_gem_framework_8h.html#a11415b43ebb41a1fc4aa64954609c347a8b96f3a36e85ca715fe56cdd9b40b32b">ER_INVALID_PATH</a>,</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;};</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="class_i_pale_gem_framework.html">   71</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_i_pale_gem_framework.html" title="Interface for the game to the engine.">IPaleGemFramework</a></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;{</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keyword">virtual</span> HRESULT <a class="code" href="class_i_pale_gem_framework.html#ad0723b0f1d9f8b8e4baeb1916000f00a" title="Initialises the game engine and creates a game window.">pgInit</a>(HINSTANCE hInstance, <span class="keywordtype">int</span> cmdShow, LPCWSTR lpGameTitle) = 0;</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_i_pale_gem_framework.html#a265588dcd93528d4449aa244fed92f56" title="Updates the engine and its subsystems.">pgUpdate</a>() = 0;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <span class="keyword">virtual</span> HRESULT <a class="code" href="class_i_pale_gem_framework.html#a7c0722e2ecb292f82771bfc4dde2c92b" title="Shuts the engine down.">pgExit</a>() = 0;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span>    <a class="code" href="class_i_pale_gem_framework.html#a16db0befad9f653ef6217aecba83087c" title="Enters the windows message loop.">pgDoMessageLoop</a>() = 0;</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span>    <a class="code" href="class_i_pale_gem_framework.html#a16db0befad9f653ef6217aecba83087c" title="Enters the windows message loop.">pgDoMessageLoop</a>(<span class="keywordtype">int</span> (*UpdateFunction) (<span class="keywordtype">float</span> fFrameTime)) = 0;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_pale_gem_framework.html#afc4e02c4fdca1ebdf3f929e64c974d55" title="Checks if there&#39;s allready an instance of the game running.">pgCheckForMultipleInstances</a>(LPCWSTR lpGameTitle) = 0;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_pale_gem_framework.html#ab5cec8d061abddec90a2bb9d60328ab0" title="Checks available memory on harddisk and returns true if theres enough.">pgCheckHardDiskSpace</a>(<span class="keyword">const</span> DWORDLONG spaceNeeded) = 0;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    </div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="comment">/*</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">    #pgCheckRAM</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment">    Checks the available system RAM</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment">    #Params</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment">    spaceNeeded:    The space to check for in bytes</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">    #Returns</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">    True if theres &gt;= spaceNeeded</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">    */</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_pale_gem_framework.html#a767e1c3dbaf56507a3abef6908cb5fe7">pgCheckRAM</a>(<span class="keyword">const</span> DWORDLONG spaceNeeded) = 0;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;    <span class="comment">/*</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">    #pgCheckAvailRAM</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">    Check the available total RAM</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">    #Params</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">    spaceNeeded:    The space to check for in bytes</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">    #Returns</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">    True if enough space is available</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">    */</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_pale_gem_framework.html#a5e2f8a348cedf1a2e5a0a15e96df3a4f">pgCheckAvailRAM</a>(<span class="keyword">const</span> DWORDLONG spaceNeeded) = 0;</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;};</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 1 2013 11:55:07 for PaleGem by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
